EyeLink Developers Kit / API                                  SR Research Ltd.

NAME
        track - EyeLink test program

SYNOPSIS
        track [-h|-help] [-darkmode] [-trackerip ADDR] [-filename NAME]
              [DISPLAYID]

DESCRIPTION
        This program is provided with the EyeLink Developers Kit / API i.e.
        Display API in order to test the EyeLink setup and its connection to a
        Display PC. It runs from the Display PC, and simultaneously
        communicates with the EyeLink while presenting real-time graphics.
        
        When first launched, track will present a menu that can be followed to
        set up the EyeLink, and to run a series of data recording trials.
        In camera setup, calibration, and validation modes, the standard
        EyeLink keyboard commands can be used from the Display PC to control
        the EyeLink.
        
        During a recording trial, the gaze or head position is read from the
        EyeLink and plotted in real time to the screen as gaze cursors. In a
        well-calibrated system, the cursors will appear on the screen at the
        spot where the subject is looking. The user may toggle between
        different combinations and types of gaze cursors, dependent on the
        version and setup of the EyeLink. Button presses will also be
        displayed if a button box or controller is connected to the EyeLink.
        
        The EyeLink records an EDF that is transferred to the Display PC after
        the file has been closed. If available, a corresponding vFile will
        also be transferred. A system file explorer window will by opened to
        show the transferred files.

OPTIONS
        -h, -help
                Print help to standard output

        -darkmode
                Uses light foreground (text and targets) on dark background,
                rather than dark foreground on light background

        -trackerip ADDR
                Connects to EyeLink using IP address ADDR, otherwise default
                address used e.g. 100.1.1.1

        -filename NAME
                EyeLink saves data to EDF called NAME. File suffix .EDF added
                automatically, if missing. Default name is sdemo.EDF.

DISPLAY ID
        The graphics will be presented to the system's primary monitor, by
        default. In a multi-monitor setup, the display can be selected by
        providing the DISPLAYID input argument as a positive, non-zero
        integer; the primary display is 1, secondary is 2, and so on.
        
        If DISPLAYID is not provided then track will look for the
        EL_USE_MONITOR environment variable, which will be interpreted in the
        same way as the DISPLAYID input argument.
        
        Should neither DISPLAYID nor EL_USE_MONITOR be avialable, then track
        will fall back to using the same display that was selected in the last
        session.

EXAMPLES
        Present graphics in the secondary monitor:
        
        $ track 2
        
        Present dark-mode graphics in the previously selected monitor:
        
        $ track -darkmode
        
        Present graphics in the primary monitor, while specifiying both the
        EyeLink's IP address and the name of the EDF (.EDF suffix added by
        track):
        
        $ track -trackerip 100.2.3.4 -filename date_subject 1

CONTACT
        Please contact support@sr-research.com with any issues experienced
        when running track. Answers to many common issues can be found online:
        <https://www.sr-research.com/support/>

NOTES
        EyeLink is a registered trademark of SR Research Ltd.

SR Research Ltd.                                Email:   info@sr-research.com
35 Beaufort Drive                               Phone:   613-271-8686 ext. 233
Ottawa, Ontario, Canada, K2L 2B9            Toll free: 1-866-821-0731 ext. 233

